Migrate documentation examples to object-based filter syntax by Copilot · Pull Request #176 · objectstack-ai/objectql

Copilot · 2026-01-23T18:23:34Z

Update Documentation Examples to New Query Syntax

This PR updates all documentation examples from the legacy array-based filter syntax to the modern object-based filter syntax.

Plan

CI Fixes Applied

Issue: TypeScript compilation errors in driver files
Root Cause:

Missing query capability properties in supports object (queryFilters, queryAggregations, etc.)
Type conflict from implementing both Driver and DriverInterface

Solutions:

Added query capability properties to all drivers:
- packages/drivers/mongo/src/index.ts
- packages/drivers/sql/src/index.ts
- packages/drivers/sdk/src/index.ts
- packages/drivers/memory/src/index.ts (already had them)
Updated type definitions:
- packages/foundation/types/src/driver.ts - Added query properties to Driver.supports
- packages/objectstack/spec/src/index.ts - Added query properties to DriverInterface.supports
Removed DriverInterface from driver implementations to avoid type conflicts (drivers now only implement Driver)

All typecheck errors resolved ✅

Original prompt

修改所有的文档例子，使用新的查询语法规范。

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

vercel · 2026-01-23T18:23:39Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Review	Updated (UTC)
objectql-site	Ready	Preview, Comment	Jan 24, 2026 0:29am

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

github-actions · 2026-01-23T23:55:12Z

⚠️ No Changeset Found

This PR does not include a changeset file.
If this PR includes user-facing changes, please add a changeset by running:

pnpm changeset

hotlong · 2026-01-24T00:21:35Z

@copilot fix all ci

…erface conflict Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Copilot · 2026-01-24T00:27:59Z

@copilot fix all ci

Fixed all CI typecheck errors in commit 86cef4e.

The issues were:

Missing query capability properties (queryFilters, queryAggregations, querySorting, queryPagination, queryWindowFunctions, querySubqueries) in driver supports objects
Type conflict from implementing both Driver and DriverInterface simultaneously

Changes made:

Added missing query properties to all driver supports objects
Updated type definitions in @objectql/types and @objectstack/spec
Removed DriverInterface from driver class implementations to resolve type conflicts

All TypeScript compilation errors are now resolved ✅

github-actions · 2026-01-24T00:53:15Z

⚠️ No Changeset Found

This PR does not include a changeset file.
If this PR includes user-facing changes, please add a changeset by running:

pnpm changeset

Copilot

Pull request overview

This PR migrates all documentation examples from the legacy array-based filter syntax to the modern object-based filter syntax, and adds query capability properties to driver type definitions to resolve TypeScript compilation errors.

Changes:

Updated filter syntax from array format [['field', '=', 'value']] to object format { field: 'value' } across all documentation and examples
Added query capability properties (queryFilters, queryAggregations, etc.) to the Driver and DriverInterface type definitions
Removed DriverInterface from the implements clause of SQL, MongoDB, and SDK drivers to avoid type conflicts

Reviewed changes

Copilot reviewed 22 out of 22 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
packages/foundation/types/src/driver.ts	Added query capability properties to Driver.supports interface
packages/objectstack/spec/src/index.ts	Added query capability properties to DriverInterface.supports
packages/drivers/sql/src/index.ts	Removed DriverInterface from implements clause and added query capability flags to supports object
packages/drivers/sdk/src/index.ts	Removed DriverInterface from implements clause and added query capability flags (window functions and subqueries set to false for remote driver)
packages/drivers/mongo/src/index.ts	Removed DriverInterface from implements clause and added query capability flags (joins, window functions, and subqueries set to false for MongoDB)
examples/showcase/project-tracker/src/seed.ts	Migrated filter from array syntax to object syntax
examples/integrations/express-server/tests/data-api.test.ts	Migrated filter from array syntax to object syntax
examples/drivers/fs-demo/src/index.ts	Migrated all filter examples to object syntax including comparison operators
examples/drivers/excel-demo/src/index.ts	Migrated all filter examples to object syntax including updateMany operation
content/docs/server/microservices.mdx	Updated filter example to object syntax
content/docs/reference/spec/validation.mdx	Updated async validation examples to use object-based filters
content/docs/reference/api/websocket.mdx	Updated WebSocket subscription filter to object syntax
content/docs/reference/api/examples.mdx	Migrated complex aggregation and search examples with nested filters and expand operations
content/docs/reference/api/client-sdk.mdx	Updated all SDK method examples including updateMany, deleteMany, and count operations
content/docs/modeling/migrations.mdx	Updated MongoDB migration examples to object syntax
content/docs/logic/formulas.mdx	Updated validation and filter expression examples throughout the documentation
content/docs/getting-started/index.mdx	Updated the getting started query example to object syntax
content/docs/data-access/sdk.mdx	Migrated all SDK examples including complex filter expressions and React hooks
content/docs/data-access/querying.mdx	Updated core querying documentation with new filter syntax and explicit OR examples
content/docs/data-access/index.mdx	Updated main data access example to object-based filters
content/docs/data-access/best-practices.mdx	Migrated all best practice examples including pagination, aggregation, and optimization patterns
content/docs/ai/coding-assistant.mdx	Updated AI assistant examples to demonstrate new filter syntax

Comments suppressed due to low confidence (5)

packages/foundation/types/src/driver.ts:130

This overload of beginTransaction() is unreachable, the previous overload will always be selected.

    beginTransaction?(): Promise<any>;

packages/foundation/types/src/driver.ts:135

This overload of disconnect() is unreachable, the previous overload will always be selected.

    disconnect?(): Promise<void>;

packages/drivers/mongo/src/index.ts:10

Unused import DriverInterface.

import { DriverInterface, QueryAST, FilterNode, SortNode } from '@objectstack/spec';

packages/drivers/sdk/src/index.ts:53

Unused import DriverInterface.

import { DriverInterface, QueryAST } from '@objectstack/spec';

packages/drivers/sql/src/index.ts:10

Unused imports DriverInterface, SortNode.

import { DriverInterface, QueryAST, FilterNode, SortNode } from '@objectstack/spec';

Copilot · 2026-01-24T01:39:08Z

+        queryFilters: true,
+        queryAggregations: true,
+        querySorting: true,
+        queryPagination: true,
+        queryWindowFunctions: true,
+        querySubqueries: true


The PR adds query capability properties (queryFilters, queryAggregations, etc.) to the SQL, MongoDB, SDK, and Memory drivers, but does not add them to the Excel, FileSystem, LocalStorage, and Redis drivers. These other drivers still implement the DriverInterface which now includes these optional properties. For consistency and completeness, these drivers should also declare their query capabilities in their supports object, even if they set them to false or their actual capability values.

Initial plan

34a92ec

Copilot AI assigned Copilot and hotlong Jan 23, 2026

vercel bot deployed to Preview January 23, 2026 18:25 View deployment

Copilot started work on behalf of hotlong January 23, 2026 18:28 View session

Copilot AI and others added 4 commits January 23, 2026 18:31

Update core documentation files with new query syntax

eb233be

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Update best-practices and formulas docs with new query syntax

c730549

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Update example code files with new query syntax

b4acbd7

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Update remaining documentation files with new query syntax

0d03737

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Update all document examples to use new query syntax~~ Migrate documentation examples to object-based filter syntax Jan 23, 2026

Copilot finished work on behalf of hotlong January 23, 2026 18:38

Copilot AI requested a review from hotlong January 23, 2026 18:38

vercel bot deployed to Preview January 23, 2026 18:41 View deployment

github-actions bot added 🧪 tests 📝 examples size/L labels Jan 23, 2026

Copilot started work on behalf of hotlong January 24, 2026 00:22 View session

Fix CI typecheck errors - update driver supports and remove DriverInt…

86cef4e

…erface conflict Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Copilot finished work on behalf of hotlong January 24, 2026 00:28

vercel bot deployed to Preview January 24, 2026 00:29 View deployment

github-actions bot added 🏗️ foundation 🔌 drivers labels Jan 24, 2026

hotlong marked this pull request as ready for review January 24, 2026 01:33

Copilot AI review requested due to automatic review settings January 24, 2026 01:33

hotlong merged commit 58a1339 into main Jan 24, 2026
5 checks passed

hotlong deleted the copilot/update-document-examples-query-syntax branch January 24, 2026 01:33

Copilot started reviewing on behalf of hotlong January 24, 2026 01:33 View session

Copilot AI reviewed Jan 24, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate documentation examples to object-based filter syntax#176

Migrate documentation examples to object-based filter syntax#176
hotlong merged 6 commits intomainfrom
copilot/update-document-examples-query-syntax

Copilot AI commented Jan 23, 2026 •

edited

Loading

Uh oh!

vercel bot commented Jan 23, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Jan 23, 2026

Uh oh!

hotlong commented Jan 24, 2026

Uh oh!

Copilot AI commented Jan 24, 2026

Uh oh!

github-actions bot commented Jan 24, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 24, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

Copilot AI commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Update Documentation Examples to New Query Syntax

Plan

CI Fixes Applied

Uh oh!

vercel bot commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jan 23, 2026

⚠️ No Changeset Found

Uh oh!

hotlong commented Jan 24, 2026

Uh oh!

Copilot AI commented Jan 24, 2026

Uh oh!

github-actions bot commented Jan 24, 2026

⚠️ No Changeset Found

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 24, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Jan 23, 2026 •

edited

Loading

vercel bot commented Jan 23, 2026 •

edited

Loading